Genie POS

Overview

Initiate push notification based payment transaction requests and returns initiated transaction details or relevant error details.

Requirements

Authorization API Calls
All API call requests to ideabiz.lk require Authorization headers. Please refer the Token Management (http://docs.ideabiz.lk/Getting_Started/Token_Manegment) document for Authorization.

Request Header

Content-Type: application/json 
Authorization: Bearer [access token] 
Accept: application/json
X-IH-SECRETCODE: `{Merchant Secret Code}`(Onetime secret code provided for the merchant integration).
X-IH-PSW: `{Merchant Password}`(Onetime password provided for the merchant integration).

Sample Request Header

Content-Type: application/json 
Authorization: Bearer a92ba8hjgjhgjh3fa1609cabcd79
Accept: application/json
X-IH-SECRETCODE:xxxxxx
X-IH-PSW:xxxxxx

If sending a unicode string with the message, please set Content-Type charset to UTF-8

Content-Type: application/json;charset=UTF-8

APIs

Initiate Push Transaction

https://ideabiz.lk/apicall/geniepos/v1/axipay/external/merchant/transaction/initiate/push

Method

POST

Parameters

Sample Request

{  
   "request":{  
      "genieAccountNumber":"+94715109942",
      "merchantPgIdentifier":"PG00007632",
      "externalMerchantTransactionId":"25",
      "chargeTotal":7000,
      "counterId":9,
      "invoiceNumber":"sdf",
      "transactionDateTime":"2018-04-12 20:12:34",
      "paymentReference":"reference"
   }
}

Sample Success Response

{
    "response": {
        "status": "success",
        "message": "Successfully initiated OTC payment. Notification sent to customer device",
        "genieTransactionId": "20180000000050698"
    }
}

Sample Failure Response

{
    "response": {
        "status": "failure",
        "message": "ExternalMerchantTransactionId must unique for transactions",
        "code": "5000"
    }
}

Initiate Push Transaction

https://ideabiz.lk/apicall/geniepos/v1/axipay/external/merchant/transaction/initiate/qr

Description

Initiate QR based payment transaction requests and returns initiated transaction details or relevant error details.

Method

POST

Parameters

Sample request

{  
   "request":{  
      "amount":"300",
      "merchantPgIdentifier":"PG00007632",
      "externalMerchantTransactionId":"1002",
      "description":"this is a test Item",
      "invoiceNumber":"1234",
      "counterId":9,
      "transactionDateTime":"2018-04-12 20:12:34"
   }
}

Sample Success Response

{
    "response": {
        "status": "success",
        "message": "success",
        "externalMerchantTransactionId": "1002",
        "genieTransactionId": "20180000000050706",
        "qrEncryptedText": "zFeB9Oqhj2V5FghbDzFjcQ=="
    }
}

Sample Failure Response

{
    "response": {
        "status": "failure",
        "message": "ExternalMerchantTransactionId must unique for transactions",
        "code": "5000"
    }
}

Get Transaction Status

https://ideabiz.lk/apicall/geniepos/v1/axipay/external/merchant/transaction/getstatus

Description

Get status of the transaction and returns transaction details or relevant error details.

Transaction Statuses

Method

POST

Parameters

You can use either externalMerchantTransactionId or genieTransactionId to retrieve the transaction status, one of them should be mandatory.

Sample request

Request with Genie Transaction Id

{  
   "request":{  
      "merchantPgIdentifier":"PG00007632",
      "genieTransactionId":"4198"
   }
}

Request with Merchant Transaction Id

{  
   "request":{  
      "merchantPgIdentifier":"PG00007632",
      "externalMerchantTransactionId":"1001"
   }
}

Sample Success Response

{
    "response": {
        "status": "success",
        "merchantTxnStatusName": "Verification Success",
        "externalMerchantTransactionId": 5069,
        "genieTransactionId": "20180000000050698",
        "transactionAmount": 7000,
        "invoiceNumber": "sdf",
        "transactionDateTime": "2018-04-12 20:12:34",
        "merchantPgIdentifier": "PG00007632"
    }
}

Sample Failure Response

{
    "response": {
        "status": "failure",
        "message": "There is no transaction record related to provided details",
        "code": "5009"
    }
}

Cancel Transaction

https://ideabiz.lk/apicall/geniepos/v1/axipay/external/merchant/transaction/cancel

Description

Cancel the transaction and returns canceled transaction details or relevant error details.

In order to cancel, the transaction should be in the status of Merchant Initiated.

Method

POST

Parameters

You can use either externalMerchantTransactionId or genieTransactionId to cancel the transaction, one of them should be mandatory.

Sample Request

{  
   "request":{  
      "externalMerchantTransactionId":1002,
      "merchantPgIdentifier":"PG00007632"
   }
}

Sample Success Response

{
    "response": {
        "status": "success",
        "message": "Successfully change the transaction status by merchant",
        "externalMerchantTransactionId": "1002",
        "genieTransactionId": "20180000000050706",
        "transactionAmount": 300,
        "invoiceNumber": "1234",
        "transactionDateTime": "2018-04-12 20:12:34",
        "merchantPgIdentifier": "PG00007632"
    }
}

Sample Failure Response

{
    "response": {
        "status": "failure",
        "message": "External Merchant verification failure.",
        "code": "5001"
    }
}

Query Transactions

https://ideabiz.lk/apicall/geniepos/v1/axipay/external/merchant/transaction/query

Description

Query transactions and returns transaction list or relevant error details.

Method

POST

Parameters

You can use either externalMerchantTransactionId or genieTransactionId to cancel the transaction, one of them should be mandatory.

Sample Request

{  
   "request":{  
      "genieTransactionId":"20180000000050340",
      "merchantPgIdentifier":"PG00007632",
      "pageStart":"10",
      "pageEnd":"20",
      "externalMerchantTransactionId": "101",
      "fromDate":"2018-04-12 20:12:34",
      "toDate":"2018-04-18 20:30:34",
      "outletId":181,
      "counterId":181
   }
}

Sample Success Response

{
    "response": {
        "transactionList": [
            {
                "genieTransactionId": "20180000000051003",
                "externalMerchantTransactionId": "101",
                "transactionDateTime": "2018-04-12 20:12:34",
                "genieAccountNumber": "+94715109942",
                "transactionAmount": 7000,
                "transactionStatus": "Customer Reject",
                "statusDescription": "Customer Reject"
            }
        ]
    }
}

Sample Failure Response

{
    "response": {
        "message": "No transactions for searching parameters.",
        "errorCode": "5014",
        "transactionList": []
    }
}

Error codes

The following table lists the error codes.